﻿/*
* Copyright (c) 2010-2012 Tesla Engine Group
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/


using System;
using Tesla.Math;

namespace Tesla.Graphics {
    /// <summary>
    /// Interface that represents an effect annotation. An annotation is a piece of metadata attached
    /// to a shader element (pass, technique, or parameter) and can contain values for editors.
    /// </summary>
    public interface IEffectAnnotation {

        /// <summary>
        /// Gets the annotation name.
        /// </summary>
        String Name {
            get;
        }

        /// <summary>
        /// Gets the semantic of the annotation.
        /// </summary>
        String Semantic {
            get;
        }

        /// <summary>
        /// Gets the parameter class of the annotation.
        /// </summary>
        EffectParameterClass ParameterClass {
            get;
        }

        /// <summary>
        /// Gets the parameter type of the annotation.
        /// </summary>
        EffectParameterType ParameterType {
            get;
        }

        /// <summary>
        /// Gets the number of columns in the class of the annotation.
        /// </summary>
        int ColumnCount {
            get;
        }

        /// <summary>
        /// Gets the number of rows in the class of the annotation.
        /// </summary>
        int RowCount {
            get;
        }


        /// <summary>
        /// Gets the value of the annotation as a bool.
        /// </summary>
        /// <returns>The bool value</returns>
        bool GetValueBool();

        /// <summary>
        /// Gets the value of the annotation as an int.
        /// </summary>
        /// <returns>The int value</returns>
        int GetValueInt();

        /// <summary>
        /// Gets the value of the annotation as a single.
        /// </summary>
        /// <returns>The single value</returns>
        float GetValueSingle();

        /// <summary>
        /// Gets the value of the annotation as a matrix.
        /// </summary>
        /// <returns>The matrix value</returns>
        Matrix GetValueMatrix();

        /// <summary>
        /// Gets the value of the annotation as a quaternion.
        /// </summary>
        /// <returns>The quaternion value</returns>
        Quaternion GetValueQuaternion();

        /// <summary>
        /// Gets the value of the annotation as a vector2.
        /// </summary>
        /// <returns>The vector2 value</returns>
        Vector2 GetValueVector2();

        /// <summary>
        /// Gets the value of the annotation as a vector3.
        /// </summary>
        /// <returns>The vector3 value</returns>
        Vector3 GetValueVector3();

        /// <summary>
        /// Gets the value of the annotation as a vector4.
        /// </summary>
        /// <returns>The vector4 value</returns>
        Vector4 GetValueVector4();

        /// <summary>
        /// Gets the value of the annotation as a string.
        /// </summary>
        /// <returns>The string value</returns>
        String GetValueString();
    }
}
